www.gusucode.com > Simulink Design Documenter 程序工具箱matlab源码 > Simulink Design Documenter/example/sldemo_househeat_doc/sldemo_househeat_doc_SDD_Config.m
% This script explains and sets configuration options for documents
% generated with GenSDD.
%
% The original version of this file has been named TopsysName_SDD_Config.m,
% TopsysName will need to be replaced with the name of the system for
% which documentation is being generated. This is also discussed in 5.2.1
% of the Guide and Reference Manual for this documentation tool.
%
% Each block of comments will describe a different variable which may be
% set by the user (examples will be written below most of these blocks of
% comments) with exception to model and topsys (these variables are
% described for reference).
% Any variable described below that is not set in this file will be set to
% its default in SDD_RPT_Setup.m. Please at least consider setting the
% subsystemList and authors variables manually.
% topsys - refers to the system which will be documented
% - this should be set by the input to the GenSDD function
% - you probably shouldn't modify this variable, but you may use
% it when setting others if it's useful
% model - refers to the model topsys is in
% - defaults to top-level system of the model topsys is in (model = bdroot(topsys);)
% - you probably shouldn't modify this variable, but you may use
% it when setting others if it's useful
% subsystemList - indicates which systems within topsys which will be documented (topsys will always be included automatically if not already included)
% - note the gcs command returns the fullpath of the current
% subsystem and may help if setting this variable manually
% - also note clicking in the address bar in Simulink will
% select the current subsystem path name (so it can be
% copied)
% - e.g. subsystemList = {<subsystem1>,<subsystem2>,...,<subsystemN>};
% - e.g. subsystemList = find_system(topsys,'SearchDepth','3','FollowLinks','on','BlockType','SubSystem','MaskType',''); %This will exclude masked subsystems
% - The default includes subsystems within the first 3 levels of topsys (and excludes DocBlocks)
subsystemList = {'sldemo_househeat_doc/House'};
% authors - author(s) of the document
authors = 'Firstname Lastname'; % Default is empty
% title - document title
title = topsys; % Default is the name of the system being documented
% subtitle - document subtitle
subtitle = 'Software Design Description'; % Default is the document type generated by this tool
% titleImage - path to image to be displayed on the title page
titleImage = 'House.PNG';
% pathToIntroSections - a path to a directory with the introductory sections (these are: Document Purpose, Scope, Definitions, and Acronyms) to be included in the document
% - default leaves this undeclared and will find the files with:
% which(['\SDD_', <section name>, '.doc']) or
% which(['\SDD_', <section name>, '.txt']) if the first is not found
% - the filenames should match this convention
% includeReqTrace - determines whether or not to include the requirements traceability section in the report
% - defaults to false
includeReqTrace = false;
% srsPath - indicates path to the requirements document associated with the model
% - the document will be linked in the generated report
% - e.g. srsPath = which('reqdoc.doc') - note that if reqdoc.doc is not found '' will be returned
srsPath = ''; % Default of '' indicates no requirements document
% allowMissingDocBlocks - determines whether warnings will or will not be displayed in the report for 'required' DocBlocks being missing
allowMissingDocBlocks = false; % Defaults to include warnings
% displayWarningSummary - determines whether the Summary of Warnings section will be displayed in the report
displayWarningSummary = true; % Defaults to include the Summary of Warnings
% getUnit - function to find a unit associated with a given block
% - defaults to return '' for all blocks
% - e.g. getUnit = @myGetUnitFunction
% %the example function below is just a quick example, the real thing should probably do more
% function unit = myGetUnitFunction(block)
% if strcmp(get_param(block,'Name'), 'Velocity')
% unit = 'm/s';
% else
% unit = '';
% end
% end
% %below is another possible function
% function unit = myGetUnitFunction(block)
% unit = get_param(block,'Unit');
% %Added in MATLAB R2016a, the unit block parameter would need
% %to be set for everything in the interface sections of the report for this to work
% end
% removeInterfaceCols - indicates which columns to not include in tables of the system interface sections of the report
% - For these variables 0s indicate columns which will be included in the SDD while 1s indicate columns which will not be included
% - The columns in order:
% Blocks/Name, Units, Min, Max, Type, Descriptions
% - e.g. [0 1 1 1 0 0] will give tables with just the Blocks/Name, Type, and Descriptions columns
removeInterfaceCols = [0 1 1 1 0 0];
% removeSubCols - indicates which columns to not include in tables of the subsystem specification sections of the report (these sections list subsystems within the current system)
% - The columns in order:
% Blocks/Name, Units, Min, Max, Type, Descriptions
% - e.g. [0 1 1 1 0 0] will give tables with just the Blocks/Name, Type, and Descriptions columns
removeSubCols = [0 1 1 1 1 0];
% abstract - abstract for the document
abstract = 'N/A'; % Default is N/A
% legalNotice - a legal notice for the document
legalNotice = ''; % Default is empty
% cal_script - indicates path to a file used to set calibrations and their values for the model
% - the calibration names, datatypes, and values will be displayed at the top of the Design Description section in the generated report
% - e.g. cal_script = [fileparts(which(mfilename)) '/' 'model_calibrations.m']; - gets a file in the same folder as the Config file with the name 'model_calibrations.m'
cal_script = ''; % Default of '' indicates no requirements document